Tests: Add missing @covers tags and refactor invalid block name tests to use a data provider#11524
Open
sagarsdeshmukh wants to merge 1 commit intoWordPress:trunkfrom
Open
Conversation
… to use a data provider.
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
This PR makes two types of test improvements across three test files.
1. Add missing
@coversannotationsAdds
@coverstags to test classes that were missing them, as part of the ongoing effort in #64225:tests/phpunit/tests/rewrite/addRewriteRule.php@covers ::add_rewrite_ruletests/phpunit/tests/rewrite/addRewriteEndpoint.php@covers ::add_rewrite_endpointtests/phpunit/tests/blocks/wpBlockTypeRegistry.php@covers WP_Block_Type_RegistryBoth
add_rewrite_rule()andadd_rewrite_endpoint()are defined insrc/wp-includes/rewrite.php.Without
@covers, PHPUnit cannot correctly attribute code coverage to the functions under test, which leads to inaccurate coverage reports on Codecov.2. Refactor repeated invalid block name tests to use a data provider
In
Tests_Blocks_wpBlockTypeRegistry, four separate test methods were structurally identical — each registered one invalid block name and assertedfalse:test_invalid_non_string_names()test_invalid_names_without_namespace()test_invalid_characters()test_uppercase_characters()These have been consolidated into a single
test_invalid_block_names()method backed by adata_invalid_block_names()data provider with named cases, following the same pattern used in recently updated tests across the suite.Before: 4 methods × ~9 lines each = ~36 lines
After: 1 method + 1 data provider = ~21 lines
Named data sets also make PHPUnit failure output more readable — instead of
test_invalid_charactersyou seetest_invalid_block_names with data set "invalid characters", which is clearer at a glance.Testing
All passing. The data provider runs each case as its own PHPUnit test, so the assertion count is unchanged.
Trac
See https://core.trac.wordpress.org/ticket/64225
This is my first contribution to WordPress core. I've enabled "Allow and access to secrets by maintainers". Happy to adjust anything based on review feedback.